GET /Service/Properties/Servers

Returns the list of PrizmDoc servers in a cluster that requests can be routed to. The list of servers returned here must first have been set by a request sent to PUT /PCCIS/V1/Service/Properties/Servers or via the Central Configuration File.

This URL is only available when PrizmDoc is running in Cluster Mode. See the PrizmDoc Cluster Mode topic for more details of this feature.

Http Method

GET

Resource URL

/PCCIS/V1/Service/Properties/Servers

Parameters

None

Request Body

None

Response Body

A JSON representation containing the IP address and port for all PrizmDoc servers in the current node.

GET http://192.168.0.1:18681/PCCIS/V1/Service/Properties/Servers

{
   "servers": [
            {
            "address": "192.168.0.1",
            "port": "18682"
            },
            {
            "address": "192.168.0.2",
            "port": "18682"
            },
            {
            "address": "192.168.0.3",
            "port": "18682"
            }
   ]
}

PUT /Service/Properties/Servers

Sets the list of PrizmDoc servers in the cluster that requests should be routed to. This list of servers is used by each PrizmDoc server's Public Port to evenly spread out the requests for new viewing sessions across all available PrizmDoc servers, as well as route request for existing viewing session to the PrizmDoc server that originally created it.

The list of servers set with this request should also include the PrizmDoc server hosting the Public Port where this list is currently being set. For example, if this request is sent to the Public Port hosted at "192.168.0.1:18681", the list of servers should include the host and port of the Cluster Port on the same sever, "192.168.0.1:18682".

This URL is only available when PrizmDoc is running in cluster mode. See the PrizmDoc Cluster Mode topic for more details of this feature.

Http Method

PUT

Resource URL

/PCCIS/V1/Service/Properties/Servers

Parameters

None

Request Body

A JSON representation containing the IP address and port for all PrizmDoc servers in the current node.

Response Body

None

PUT http://192.168.0.1:18681/PCCIS/V1/Service/Properties/Servers
{
   "servers": [
            {
            "address": "192.168.0.1",
            "port": "18682"
            },
            {
            "address": "192.168.0.2",
            "port": "18682"
            },
            {
            "address": "192.168.0.3",
            "port": "18682"
            }
   ]
}

200 OK